/*
Copyright 2008-2010 Gephi
Authors : Mathieu Bastian <mathieu.bastian@gephi.org>, Andre Panisson <panisson@gmail.com>
Website : http://www.gephi.org

This file is part of Gephi.

DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

Copyright 2011 Gephi Consortium. All rights reserved.

The contents of this file are subject to the terms of either the GNU
General Public License Version 3 only ("GPL") or the Common
Development and Distribution License("CDDL") (collectively, the
"License"). You may not use this file except in compliance with the
License. You can obtain a copy of the License at
http://gephi.org/about/legal/license-notice/
or /cddl-1.0.txt and /gpl-3.0.txt. See the License for the
specific language governing permissions and limitations under the
License.  When distributing the software, include this License Header
Notice in each file and include the License files at
/cddl-1.0.txt and /gpl-3.0.txt. If applicable, add the following below the
License Header, with the fields enclosed by brackets [] replaced by
your own identifying information:
"Portions Copyrighted [year] [name of copyright owner]"

If you wish your version of this file to be governed by only the CDDL
or only the GPL Version 3, indicate your decision by adding
"[Contributor] elects to include this software in this distribution
under the [CDDL or GPL Version 3] license." If you do not indicate a
single choice of license, a recipient has the option to distribute
your version of this file under either the CDDL, the GPL Version 3 or
to extend the choice of license to its licensees as provided above.
However, if you add GPL Version 3 code and therefore, elected the GPL
Version 3 license, then the option applies only if the new code is
made subject to such option by the copyright holder.

Contributor(s):

Portions Copyrighted 2011 Gephi Consortium.
 */

package org.gephi.streaming.api;

import java.io.IOException;
import org.gephi.graph.api.Graph;

/**
 * Controller to connect to graph streams and update graphs accordingly.
 *
 * @author panisson
 */
public interface StreamingController {

    /**
     * <p>This is used to connect to a StreamingEndpoint. The connection will be
     * bound with the Graph object: any event received in the stream will cause
     * an update in the graph, and updates in the graph will cause an event
     * to be sent to the StreamingEndpoint.
     * <p>Note that the connection will not start to be processed immediately after
     * created. You should call connection.process() to star processing it:
     * <pre> StreamingController controller = Lookup.getDefault().lookup(StreamingController.class);
     * StreamingConnection connection = controller.connect(endpoint, graph);
     * connection.process(); </pre>
     *
     * @param endpoint - the StreamingEndpoint to connect to
     * @param graph - the Graph that will be updated with the events
     * @return the streaming connection
     * @throws IOException
     */
    public StreamingConnection connect(StreamingEndpoint endpoint, Graph graph)
            throws IOException;

    /**
     * <p>This is used to connect to a StreamingEndpoint. The connection will be
     * bound with the Graph object: any event received in the stream will cause
     * an update in the graph, and updates in the graph will cause an event
     * to be sent to the StreamingEndpoint.
     * The Report object will be updated
     * with useful information.
     * <p>Note that the connection will not start to be processed immediately after
     * created. You should call connection.process() to star processing it:
     * <pre> StreamingController controller = Lookup.getDefault().lookup(StreamingController.class);
     * Report report = new Report();
     * StreamingConnection connection = controller.connect(endpoint, graph, report);
     * connection.process(); </pre>
     *
     * @param endpoint - the StreamingEndpoint to connect to
     * @param graph - the Graph that will be updated with the events
     * @param report - the Report object that will be updated with information
     * @return the streaming connection
     * @throws IOException
     */
    public StreamingConnection connect(StreamingEndpoint endpoint, Graph graph,
            Report report)
            throws IOException;

    /**
     * Utility function to get the stream implementation for a given stream type.
     *
     * @param streamType - the String representation of the stream type
     * @return the stream type implementation
     */
    public StreamType getStreamType(String streamType);
}
